Catalogs
You can obtain a list of the available catalogs and their parameters. A catalog corresponds to a project in AtScale.
Request
A query for catalogs must include the following:
- The SELECT statement must start with one or more catalog parameters (comma separated).
- After the parameters you must provide the following data source:
FROM $system.DBSCHEMA_CATALOGS
You can request the following catalog parameters:
- CATALOG_GUID
- CATALOG_NAME
- COMPATIBILITY_LEVEL
- DATE_MODIFIED
- DESCRIPTION
- TYPE
- VERSION
For details about the parameter types, see the xsd:schema
element in
the sample response provided below.
Response
The response contains a <row>
element for each catalog. Each of these
elements contains the values of the requested parameters.
The value of the CATALOG_NAME
parameter is often required when
performing other queries for the Data Catalog API.
Sample request
The example here shows how to make a request with the curl
tool:
- The requested data are the name (CATALOG_NAME) and description (DESCRIPTION).
- The token is obtained in advance.
- The query is for the default organization.
- The address of the AtScale system is:
http://example.com:10502/xmla/default
The XML part of the request is as follows:
<?xml version="1.0"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<Execute xmlns="urn:schemas-microsoft-com:xml-analysis">
<Command>
<Statement>SELECT CATALOG_NAME, DESCRIPTION FROM $system.DBSCHEMA_CATALOGS</Statement>
</Command>
</Execute>
</Body>
</Envelope>
Here is the full form of the curl request:
curl -X POST \
-H "Authorization:Bearer $token" -H 'Content-Type: application/xml' \
-d '<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">\
<Body><Execute xmlns="urn:schemas-microsoft-com:xml-analysis">\
<Command>\
<Statement>SELECT CATALOG_NAME, DESCRIPTION FROM $system.DBSCHEMA_CATALOGS</Statement>\
</Command>\
</Execute></Body></Envelope>' \
http://example.com:10502/xmla/default
Sample response
The response for the sample request above contains <row>
elements for
each catalog found. As requested, each of these elements contains only
the name and description of the catalog:
<row>
<CATALOG_NAME>Sales Insights</CATALOG_NAME>
<DESCRIPTION/>
</row>
<row>
<CATALOG_NAME>Weather</CATALOG_NAME>
<DESCRIPTION/>
</row>
Here is the full response:
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<as:queryId xmlns:as="http://xsd.atscale.com/soap_v1" soap:mustUnderstand="0">063833d5-5cb9-4b5d-9580-fb0280803f98</as:queryId>
</soap:Header>
<soap:Body>
<ExecuteResponse xmlns="urn:schemas-microsoft-com:xml-analysis">
<return>
<root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" xmlns:msxmla="http://schemas.microsoft.com/analysisservices/2003/xmla" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:schema xmlns:sql="urn:schemas-microsoft-com:xml-sql" targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" elementFormDefault="qualified">
<xsd:element name="root">
<xsd:complexType>
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:element name="row" type="row"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:simpleType name="uuid">
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="xmlDocument">
<xsd:sequence>
<xsd:any/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="row">
<xsd:sequence>
<xsd:element sql:field="CATALOG_NAME" name="CATALOG_NAME" type="xsd:string" minOccurs="0"/>
<xsd:element sql:field="DESCRIPTION" name="DESCRIPTION" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
<row>
<CATALOG_NAME>Sales Insights</CATALOG_NAME>
<DESCRIPTION/>
</row>
<row>
<CATALOG_NAME>Weather</CATALOG_NAME>
<DESCRIPTION/>
</row>
</root>
</return>
</ExecuteResponse>
</soap:Body>
</soap:Envelope>
More information
- Request reference: How to make requests to the Data Catalog API.
- Response reference: How to receive and process responses from the Data Catalog API.